home *** CD-ROM | disk | FTP | other *** search
/ BCI NET / BCI NET Dec 94.iso / archives / programming / languages / frexxedv10.lha / fpl / Comment.FPL.README < prev    next >
Encoding:
Text File  |  1994-11-05  |  2.1 KB  |  55 lines
  1. #############################################################################
  2. File:                Comment.FPL
  3. Author:                Jesper Skov
  4. Email:                jskov@iesd.auc.dk
  5. Short:                Easy source code commenting
  6. Version:            1.2
  7. Date:                5.11.94
  8. Local settings:        comment_column,wall_right, (c_mode, asm_mode)
  9. Global settings:
  10. Keysequence:        "'esc' ;" and "'esc' :"
  11. Type:                function
  12. Prereq:                (Center.FPL)
  13. Copyright:            Jesper Skov
  14.                     Use/distribute according to the terms of GNU GPL.
  15.                     (See the file 'COPYING.GNU' for more info!)
  16. #############################################################################
  17.  
  18. FUNCTION
  19.   These two functions (LineComment and EOLComment) will make it a bit
  20.   easier to retain (or rather write) a well commented source code.
  21.  
  22.   The EOLComment function is a copy-cat of the Emacs "indent-for-comment"
  23.   function. The 'c_mode' and 'asm_mode' flags are used to determine which
  24.   comment style should be used. The (local) variable 'comment_column'
  25.   (+1 actually) specify at which column the comment should be set.
  26.   Activate by pressing <'esc' ;>. Example:
  27.                                            /* Testing 1-2-3 */
  28.  
  29.   The LineComment function gives you an easy way of (visually) splitting the
  30.   source code into function/routine "areas". When invoking the function with
  31.   <'esc' :> you will be asked for a describing text, which will be right-
  32.   justified in the comment block. Example:
  33.   
  34. /*****************************************************************************
  35. ************************************ This comment is created by LineComment **
  36. *****************************************************************************/
  37.  
  38.   The width of the comment block may be controlled with the wall_right
  39.   variable. The startstop character (here '/') and the body character
  40.   (here '*') depend on the c_mode and asm_mode flags.
  41.   An empty string cancels the operation (as does the Cancel gadget :)
  42.  
  43.  
  44. HISTORY (REV)
  45.   09.10.94 (0)    Initial revision
  46.   23.10.94 (1)    ReadInfo("linelength") -> ReadInfo("line_length")
  47.   05.11.94 (2)  Now creates the 'wall_right' info variable.
  48.  
  49. BUGS
  50.   Nah, not today anyway :)
  51.  
  52. SEE ALSO
  53.   C.J.Cherryh's "The Paladin" (ISBN: 0-671-65417-9)
  54.  
  55.